/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * -------------------------------------------------------------------
 *
 * History
 *   24.06.2010 (hofer): created
 */
package org.knime.base.node.preproc.autobinner.apply;

import org.knime.core.data.DataCell;
import org.knime.core.data.DoubleValue;

/**
 * Encapsulates a bin.
 *
 * @author Heiko Hofer
 */
class NumericBin  {
    private final DataCell m_binName;

    private final boolean m_isLeftOpen;

    private final double m_leftMargin;

    private final boolean m_isRightOpen;

    private final double m_rightMargin;

    /**
     *
     * @param binName the value of the bin
     * @param isLeftOpen <code>true</code> if left interval is open
     * @param leftMargin the left interval margin
     * @param isRightOpen <code>true</code> if the right interval is open
     * @param rightMargin the right interval margin
     */
    NumericBin(final DataCell binName, final boolean isLeftOpen,
            final double leftMargin, final boolean isRightOpen,
            final double rightMargin) {
        m_binName = binName;
        m_isLeftOpen = isLeftOpen;
        m_leftMargin = leftMargin;
        m_isRightOpen = isRightOpen;
        m_rightMargin = rightMargin;
    }

    /**
     * @return the value of a bin
     */
    public DataCell getValue() {
        return m_binName;
    }

    /**
     * @param cell the cell to check coverage
     * @return <code>true</code>, if interval covers the given value
     * @throws ClassCastException if the cell is not of type {@link DoubleValue}
     */
    public boolean covers(final DataCell cell) {
        if (cell.isMissing()) {
            return false;
        }
        double value = ((DoubleValue)cell).getDoubleValue();
        assert (m_leftMargin <= m_rightMargin);
        if (m_leftMargin < value && value < m_rightMargin) {
            return true;
        }
        if (m_leftMargin == value && !m_isLeftOpen) {
            return true;
        }
        if (m_rightMargin == value && !m_isRightOpen) {
            return true;
        }
        return false;
    }
}
